/* Copyright (C) 2008  Romolo Camplani, Marco Fortunato, Marco Marelli, Guido Rota, Fabio A. Schreiber et al.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.dei.perla.utils.waiter;

import org.dei.perla.component.Component;

/**
 * Oggetto Waitable, in grado di registrarsi ad un Waiter e di 
 * notificare degli eventi 
 */
public class Waitable<T extends Component> {

	/**
	 * Indica se l'oggetto Waitable e' in stato di Signaled (cioe' se ha notificato un evento)
	 */
	private volatile boolean pSignaled;
	
	/**
	 * Riferimento all'oggetto Waiter a cui l'oggetto Waitable e' agganciato (null se non e' correntemente agganciato)
	 */
	private Waiter<T> pWaiter;
	
	/**
	 * Riferimento al componente padre
	 */
	private final T pParentComponent;
	
	/**
	 * Costruttore
	 */
	public Waitable(T parParentComponent) {
		pSignaled = false;
		pWaiter = null;
		this.pParentComponent = parParentComponent;
	}
	
	/**
	 * Restituisce un riferimento al componente padre
	 */
	public T getParentComponent() {
		return pParentComponent;
	}
	
	/**
	 * Metodo internal usato dal Waiter per agganciare l'oggetto Waitable
	 */
	void setWaiter(Waiter<T> parWaiter) {
		this.pWaiter = parWaiter;
	}
	
	/**
	 * Metodo internal che restituisce il riferimento all'oggetto Waiter a cui 
	 * l'oggetto Waitable e' correntemente agganciato
	 */
	Waiter<T> getWaiter() {
		return pWaiter;
	}
	
	/**
	 * Metodo internal per permettere al Waiter di conoscere lo stato del flag 
	 * Signaled dell'oggetto Waitable 
	 */
	boolean getSignaled() {
		return pSignaled;
	}
	
	/**
	 * Metodo per notificare l'inizio di un evento al Waiter  
	 */
	public void notifyWaiter() {
		pSignaled = true;
		synchronized (this) {
			if(this.pWaiter != null) {
				synchronized (pWaiter.pSyncronizationObject) {
					pWaiter.pSyncronizationObject.notifyAll();
				}
			}
		} 
	}
	
	/**
	 * Metodo per notificare la fine di un evento al Waiter  
	 */
	public void resetWaiter() {
		pSignaled = false;
		synchronized (this) {
			if(this.pWaiter != null) {
				synchronized (pWaiter.pSyncronizationObject) {
					pWaiter.pSyncronizationObject.notifyAll();
				}
			}
		}
	}
}
